feat: rename schema to valueSchema #1482
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 449bde4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 28 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
alvrs
force-pushed
the
alvrs/rename-value-schema
branch
from
b479643 to
f29829c
Compare
dk1a
previously approved these changes
Sep 14, 2023
holic
previously approved these changes
Sep 14, 2023
holic
reviewed
Sep 14, 2023
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
alvrs
force-pushed
the
alvrs/rename-value-schema
branch
from
9348d50 to
26df50f
Compare
alvrs
force-pushed
the
alvrs/rename-value-schema
branch
from
4189c86 to
14582af
Compare
holic
reviewed
Sep 15, 2023
| @@ -127,7 +127,6 @@ The client package will vary depending on which template used (vanilla, react, p | |||
|
|
|||
| - You can adjust `createClientComponents.ts` to either override contract components or add client-only components. | |||
| - If you are using chains other than foundry/anvil and lattice testnet, you can add them in `getNetworkConfig.ts` | |||
| - `createSystemCalls` represents how the client talks to the system contracts via our `worldSend` helper | |||
There was a problem hiding this comment.
fwiw we still have and use createSystemCalls, we just go through worldContract.write instead
| @@ -45,7 +45,7 @@ For the sake of simplicity, we will implement this in the `increment` function r | |||
| A MUD table has two schemas: | |||
|
|
|||
| - `keySchema`, the key used to find entries | |||
| - `schema`, the value in the entry (soon to be renamed to `valueSchema`) | |||
| - `valueSchema`, the value in the entry | |||
| keySchema?: Record<string, KeySchema<StaticUserTypes>>; | ||
| /** Table's column names mapped to their types. Table name's 1st letter should be lowercase. */ | ||
| schema: SchemaConfig<UserTypes>; | ||
| /** Table's field names mapped to their types. Table name's 1st letter should be lowercase. */ |
There was a problem hiding this comment.
the second sentence here is weird, should this be "field name's first letter"?
| // to store, while `getField` loads it from storage. Remove this once we have support for passing the | ||
| // schema in `getField` too. (See https://github.com/latticexyz/mud/issues/444) | ||
| // valueSchema in `getField` too. (See https://github.com/latticexyz/mud/issues/444) |
There was a problem hiding this comment.
I think getField now supports passing in value schema (or field layout now) so is this comment/workaround still relevant?
There was a problem hiding this comment.
true, will remove this in a followup
holic
approved these changes
Sep 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1129